/*
 * Copyright (c) 2021, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.
 *
 *  WSO2 Inc. licenses this file to you under the Apache License,
 *  Version 2.0 (the "License"); you may not use this file except
 *  in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing,
 *  software distributed under the License is distributed on an
 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *  KIND, either express or implied.  See the License for the
 *  specific language governing permissions and limitations
 *  under the License.
 */

package org.wso2.carbon.identity.application.mgt.validator;

import org.wso2.carbon.identity.application.common.IdentityApplicationManagementException;
import org.wso2.carbon.identity.application.common.model.ServiceProvider;

import java.util.List;

/**
 * Validator for the application which will be triggered in application related operations.
 */
public interface ApplicationValidator {

    /**
     * Get the execution order of the validator.
     *
     * @return Order id.
     */
    int getOrderId();

    /**
     * Validate the Application configuration and return error messages to be returned to the client.
     *
     * @param serviceProvider   Service provider.
     * @param tenantDomain      Tenant domain name corresponding to the tenant.
     * @param username          The user who was invoking the application action.
     * @return                  List of error message found during validation.
     * @throws IdentityApplicationManagementException IdentityApplicationManagementException.
     */
    List<String> validateApplication(ServiceProvider serviceProvider, String tenantDomain, String username)
            throws IdentityApplicationManagementException;
}
